Xbasic

A5_SQL_ImportDataSource Function

Syntax

Result as P = a5_SQL_ImportDataSource(P ds ,C tablename [,L AddTableToDatabase [,* arguments [,* options [,* openConnection [,L showProgress [,L allowCancel ]]]]]])

Arguments

Result

A dot variable that describes the result of the operation.

Element
Type and Description
.error

L .T. indicates that an error occurred

.errorText

C A text description of any error that occurred.

ds

A dot variable that describes the data to be retrieved. See Data Source Data Structure.

tablename

Optional. The name of the table to refresh. The path of the current database is assumed.

AddTableToDatabase

Logical. Optional.

arguments

Optional. Default = NULL_VALUE(). Arguments that retrieve value(s) from variable(s) or prompts for value(s) at runtime. Only applicable to SQL Reports. Refer to SQL::Arguments Object.

options

Optional. Default = NULL_VALUE(). Sets filter (WHERE) and order (ORDER BY) expressions for a query against a passive-linked table. A pointer dot variable with 2 elements. Refer to Using the Options Argument.

Element

Type and Description

.filter

C Adds to the WHERE clause in the underlying SQL expression.

.order

C Replaces the ORDER BY clause in the underlying SQL expression.

openConnection

Optional. Default = NULL_VALUE().

showProgress

Logical. Optional. Default = NULL_VALUE().

allowCancel

Logical. Optional. Default = NULL_VALUE().

Description

The A5_SQL_ImportDataSource() function imports the data specified by a Data Source name to an Alpha Anywhere table.

Limitations

Desktop applications only.

See Also